/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.rocketmq.remoting;

import org.apache.rocketmq.remoting.exception.RemotingConnectException;
import org.apache.rocketmq.remoting.exception.RemotingSendRequestException;
import org.apache.rocketmq.remoting.exception.RemotingTimeoutException;
import org.apache.rocketmq.remoting.exception.RemotingTooMuchRequestException;
import org.apache.rocketmq.remoting.netty.NettyRequestProcessor;
import org.apache.rocketmq.remoting.protocol.RemotingCommand;

import java.util.List;
import java.util.concurrent.ExecutorService;

/**
 * 客户端
 */
public interface RemotingClient extends RemotingService {

    /**
     * 修改NameServer地址列表
     */
    void updateNameServerAddressList(final List<String> addrs);

    /**
     * 返回NameServer地址列表
     */
    List<String> getNameServerAddressList();

    /**
     * 已同步的方式,处理请求request
     *
     * @param addr          客户端连接的服务端地址.可能是NameServer的地址,也可能是broker的地址.
     * @param request       请求数据包
     * @param timeoutMillis 超时时间
     */
    RemotingCommand invokeSync(final String addr, final RemotingCommand request, final long timeoutMillis)
            throws InterruptedException, RemotingConnectException, RemotingSendRequestException, RemotingTimeoutException;

    /**
     * 异步处理请求
     *
     * @param addr           客户端连接的服务端地址.可能是NameServer的地址,也可能是broker的地址.
     * @param request        请求数据包
     * @param timeoutMillis  超时时间
     * @param invokeCallback 异步处理之后,回调函数
     */
    void invokeAsync(final String addr, final RemotingCommand request, final long timeoutMillis, final InvokeCallback invokeCallback)
            throws InterruptedException, RemotingConnectException, RemotingTooMuchRequestException, RemotingTimeoutException, RemotingSendRequestException;

    void invokeOneway(final String addr, final RemotingCommand request, final long timeoutMillis)
            throws InterruptedException, RemotingConnectException, RemotingTooMuchRequestException, RemotingTimeoutException, RemotingSendRequestException;

    /**
     * 注册处理器及线程池
     *
     * @param requestCode 请求code org.apache.rocketmq.common.protocol.RequestCode
     * @param processor   处理器:这个请求使用哪个处理器来处理
     * @param executor    处理这个请求的时候,在哪个线程池中执行
     */
    void registerProcessor(final int requestCode, final NettyRequestProcessor processor, final ExecutorService executor);

    /**
     * 设置callback在哪个线程池中执行
     */
    void setCallbackExecutor(final ExecutorService callbackExecutor);

    ExecutorService getCallbackExecutor();

    /**
     * 当前client连接的服务端地址,是否可写.
     *
     * @param addr 服务端地址,可能是NameServer,也可能是broker
     */
    boolean isChannelWritable(final String addr);
}
